noVNC console integration by davidjumani · Pull Request #3967 · apache/cloudstack

davidjumani · 2020-03-16T06:53:57Z

Description

This feature provides novnc console for virtual machines.

It is developed based on noVNC 1.1.0
It includes changes in cloudstack :
(1) add a new websocket proxy to interact with the noVNC console
(2) a ConsoleProxyClient to read / write data from the vm vnc to the websocket.

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)

Screenshots (if appropriate):

How Has This Been Tested?

(1) Works on kvm / ubuntu / centos
(2) Works on xs 75
(3) Works on VMware 6.5

blueorangutan · 2020-03-16T08:18:36Z

Packaging result: ✖centos6 ✔centos7 ✔debian. JID-1053

blueorangutan · 2020-03-16T10:09:34Z

Packaging result: ✖centos6 ✔centos7 ✔debian. JID-1054

blueorangutan · 2020-03-17T09:56:55Z

Packaging result: ✖centos6 ✔centos7 ✔debian. JID-1065

davidjumani · 2020-03-18T06:28:29Z

@ustcweizhou I've created this to use a java websocket proxy which supports client metrics reporting. Could you provide your comments

weizhouapache · 2020-03-18T08:36:01Z

@davidjumani cooooool.
I am currently busy on some other stuff. I will look at it when I am free.
@rhtyd has some ideas. maybe he can help you.

davidjumani · 2020-03-20T04:37:36Z

@rhtyd It's all good from my end, any comments ?

nvazquez · 2020-03-26T12:10:59Z

@blueorangutan package

blueorangutan · 2020-03-26T12:11:20Z

@nvazquez a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

blueorangutan · 2020-03-26T12:37:23Z

Packaging result: ✔centos7 ✔debian. JID-1094

nvazquez

Thanks @davidjumani. I have tested manually and works nice. I have left some few comments and also wondering if we could include a jar instead of the noVNC codebase on the console proxy VM and serve it. Otherwise LGTM

nvazquez · 2020-03-26T20:16:42Z

server/src/main/java/com/cloud/servlet/ConsoleProxyServlet.java

+        if (param.getHypervHost() != null || !ConsoleProxyManager.NoVncConsoleDefault.value()) {
+            sb.append("/ajax?token=" + encryptor.encryptObject(ConsoleProxyClientParam.class, param));
+        } else {
+            sb.append("/resource/noVNC/vnc_lite.html?port=" + ConsoleProxyManager.DEFAULT_NOVNC_PORT + "&token="


Why not using vnc.html which provides more functionalities? Briefly tested invoking it and got this extra functionalities:

Wanted a simpler, minimalist UI, can add this when we get multi lingual keyboard working

nvazquez · 2020-03-26T20:20:36Z

server/src/main/java/com/cloud/consoleproxy/ConsoleProxyManager.java

    public static final String CERTIFICATE_NAME = "CPVMCertificate";

+    public static final ConfigKey<Boolean> NoVncConsoleDefault = new ConfigKey<Boolean>("Advanced", Boolean.class, "novnc.console.default", "true",
+        "If true, noVNC console will be default console for virtual machines", true);


I think it should be disabled by default at least until all hypervisors tested working properly

I've tested it on KVM, VMware and Xen and it works fine!

borisstoyanov · 2020-03-30T08:08:24Z

@blueorangutan package

blueorangutan · 2020-03-30T08:09:36Z

@borisstoyanov a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

blueorangutan · 2020-03-30T08:42:25Z

Packaging result: ✔centos7 ✔debian. JID-1104

vladimirpetrov · 2020-04-02T12:11:53Z

@blueorangutan test

borisstoyanov · 2020-04-02T12:24:51Z

@blueorangutan test

blueorangutan · 2020-04-02T12:26:05Z

@borisstoyanov a Trillian-Jenkins test job (centos7 mgmt + kvm-centos7) has been kicked to run smoke tests

vladimirpetrov · 2020-04-03T08:35:22Z

@blueorangutan help

blueorangutan · 2020-04-03T08:36:08Z

@vladimirpetrov I understand these words: "help", "hello", "thanks", "package", "test"
Test command usage: test [mgmt os] [hypervisor] [additional tests]
Mgmt OS options: ['centos6', 'centos7', 'ubuntu']
Hypervisor options: ['kvm-centos6', 'kvm-centos7', 'kvm-ubuntu', 'xenserver-71', 'xenserver-65sp1', 'xenserver-62sp1', 'vmware-67u3', 'vmware-65u2', 'vmware-60u2', 'vmware-55u3', 'vmware-51u1', 'vmware-50u1']
Additional tests: list of space separated tests with paths relative to the test/integration directory, for example: component/test_acl_listvm.py component/test_volumes.py
Note: when additional tests are passed, you need to specify mgmt server os and hypervisor or use the matrix command.

Blessed contributors for kicking Trillian test jobs: ['rhtyd', 'nvazquez', 'PaulAngus', 'borisstoyanov', 'DaanHoogland', 'shwstppr', 'andrijapanicsb', 'Spaceman1984', 'Pearl1594', 'davidjumani', 'harikrishna-patnala', 'vladimirpetrov']

vladimirpetrov · 2020-04-06T12:15:15Z

@blueorangutan package

davidjumani · 2020-04-14T11:10:49Z

Verified with multi keyboard layouts! Have to configure the appropriate keyboard layout in the guest VM

vladimirpetrov · 2020-04-14T12:07:43Z

@blueorangutan package

blueorangutan · 2020-04-14T12:09:00Z

@vladimirpetrov a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

vladimirpetrov · 2020-04-15T10:25:42Z

@blueorangutan package

blueorangutan · 2020-04-15T10:26:59Z

@vladimirpetrov a Jenkins job has been kicked to build packages. I'll keep you posted as I make progress.

blueorangutan · 2020-04-15T10:52:39Z

Packaging result: ✔centos7 ✔debian. JID-1168

andrijapanicsb · 2020-05-14T21:52:12Z

@blueorangutan test

blueorangutan · 2020-05-14T21:53:05Z

@andrijapanicsb a Trillian-Jenkins test job (centos7 mgmt + kvm-centos7) has been kicked to run smoke tests

blueorangutan · 2020-05-15T08:44:34Z

Trillian test result (tid-1531)
Environment: kvm-centos7 (x2), Advanced Networking with Mgmt server 7
Total time taken: 37093 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr3967-t1531-kvm-centos7.zip
Intermittent failure detected: /marvin/tests/smoke/test_hostha_kvm.py
Smoke tests completed. 83 look OK, 0 have error(s)
Only failed tests results shown below:

Test	Result	Time (s)	Test File

blueorangutan · 2020-05-16T09:59:52Z

Packaging result: ✔centos7 ✔debian. JID-1229

blueorangutan · 2020-05-16T21:07:53Z

Packaging result: ✔centos7 ✔debian. JID-1230

andrijapanicsb

LGTM

tested manually as well.

andrijapanicsb · 2020-05-19T12:13:54Z

Travis log length exceeded - otherwise LGMT

Merging based on 2 x LGTMs, manual testing by 2 persons (Vladimir and me) and the regression test results passing 100%.

DaanHoogland · 2020-05-20T14:07:52Z

@davidjumani please have a look at https://builds.apache.org/job/cloudstack-pr-analysis/10377/artifact/target/rat.txt or equivalent of any new PR. it seems we missed some licensing checks on this PR.

* Adding noVNC repo * Adding support for noVNC * Adding Ctl+Esc * Removing device name from novnc header

davidjumani changed the title ~~Adding novnc~~ noVNC console integration Mar 16, 2020

davidjumani force-pushed the adding-novnc branch 2 times, most recently from 49b94fc to 7aba8b1 Compare March 16, 2020 09:45

svenvogel added type:enhancement component:console-proxy labels Mar 16, 2020

davidjumani added 2 commits March 17, 2020 14:56

Adding noVNC repo

f00aaad

Adding support for noVNC

f246c43

davidjumani force-pushed the adding-novnc branch from 7aba8b1 to f246c43 Compare March 17, 2020 09:29

davidjumani marked this pull request as ready for review March 20, 2020 04:34

nvazquez approved these changes Mar 26, 2020

View reviewed changes

apache deleted a comment from blueorangutan Apr 3, 2020

apache deleted a comment from vladimirpetrov Apr 3, 2020

DaanHoogland added this to the 4.15.0.0 milestone May 8, 2020

apache deleted a comment from blueorangutan May 14, 2020

andrijapanicsb changed the title ~~noVNC console integration~~ [WIP - do not merge] noVNC console integration May 15, 2020

Removing device name from novnc header

6dc1467

DaanHoogland marked this pull request as draft May 18, 2020 10:48

DaanHoogland changed the title ~~[WIP - do not merge] noVNC console integration~~ noVNC console integration May 18, 2020

andrijapanicsb closed this May 19, 2020

andrijapanicsb reopened this May 19, 2020

davidjumani marked this pull request as ready for review May 19, 2020 11:02

andrijapanicsb self-requested a review May 19, 2020 11:20

andrijapanicsb approved these changes May 19, 2020

View reviewed changes

andrijapanicsb merged commit 1756b0f into apache:master May 19, 2020

davidjumani deleted the adding-novnc branch May 19, 2020 14:33

DaanHoogland mentioned this pull request May 25, 2020

Adding novnc license exclusion #4097

Merged

5 tasks

soreana pushed a commit to soreana/cloudstack that referenced this pull request Nov 3, 2020

noVNC console integration (apache#3967)

fbc8df2

* Adding noVNC repo * Adding support for noVNC * Adding Ctl+Esc * Removing device name from novnc header

DaanHoogland pushed a commit to shapeblue/cloudstack that referenced this pull request May 20, 2022

noVNC console integration (apache#3967)

eb526da

* Adding noVNC repo * Adding support for noVNC * Adding Ctl+Esc * Removing device name from novnc header

shwstppr pushed a commit to shapeblue/cloudstack that referenced this pull request Jan 17, 2023

noVNC console integration (apache#3967)

f6829ac

* Adding noVNC repo * Adding support for noVNC * Adding Ctl+Esc * Removing device name from novnc header

Conversation

davidjumani commented Mar 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Screenshots (if appropriate):

How Has This Been Tested?

Uh oh!

blueorangutan commented Mar 16, 2020

Uh oh!

blueorangutan commented Mar 16, 2020

Uh oh!

blueorangutan commented Mar 17, 2020

Uh oh!

davidjumani commented Mar 18, 2020

Uh oh!

weizhouapache commented Mar 18, 2020

Uh oh!

davidjumani commented Mar 20, 2020

Uh oh!

nvazquez commented Mar 26, 2020

Uh oh!

blueorangutan commented Mar 26, 2020

Uh oh!

blueorangutan commented Mar 26, 2020

Uh oh!

nvazquez left a comment

Choose a reason for hiding this comment

Uh oh!

nvazquez Mar 26, 2020

Choose a reason for hiding this comment

Uh oh!

davidjumani Mar 27, 2020

Choose a reason for hiding this comment

Uh oh!

nvazquez Mar 26, 2020

Choose a reason for hiding this comment

Uh oh!

davidjumani Mar 27, 2020

Choose a reason for hiding this comment

Uh oh!

borisstoyanov commented Mar 30, 2020

Uh oh!

blueorangutan commented Mar 30, 2020

Uh oh!

blueorangutan commented Mar 30, 2020

Uh oh!

vladimirpetrov commented Apr 2, 2020

Uh oh!

borisstoyanov commented Apr 2, 2020

Uh oh!

blueorangutan commented Apr 2, 2020

Uh oh!

vladimirpetrov commented Apr 3, 2020

Uh oh!

blueorangutan commented Apr 3, 2020

Uh oh!

vladimirpetrov commented Apr 6, 2020

Uh oh!

davidjumani commented Apr 14, 2020

Uh oh!

vladimirpetrov commented Apr 14, 2020

Uh oh!

blueorangutan commented Apr 14, 2020

Uh oh!

vladimirpetrov commented Apr 15, 2020

Uh oh!

blueorangutan commented Apr 15, 2020

Uh oh!

blueorangutan commented Apr 15, 2020

Uh oh!

andrijapanicsb commented May 14, 2020

Uh oh!

blueorangutan commented May 14, 2020

Uh oh!

blueorangutan commented May 15, 2020

Uh oh!

blueorangutan commented May 16, 2020

Uh oh!

blueorangutan commented May 16, 2020

davidjumani commented Mar 16, 2020 •

edited

Loading